@fortawesome/fontawesome-common-types

What is @fortawesome/fontawesome-common-types?

The @fortawesome/fontawesome-common-types npm package provides TypeScript definitions for common types used across the Font Awesome ecosystem. This package is primarily intended for internal use by other Font Awesome packages to ensure consistent type definitions across the suite of Font Awesome tools and components. It includes types for icons, icon styles, and other configurations.

What are @fortawesome/fontawesome-common-types's main functionalities?

IconDefinition

Defines the structure of an icon definition, including its name, style prefix, and SVG path data. This is crucial for ensuring that icons are consistently defined and used across different Font Awesome components.

{"prefix": "fas", "iconName": "user", "icon": [512, 512, [], "f007", "M...Path"]}

IconPrefix

Specifies the available style prefixes for Font Awesome icons, such as solid (`fas`), regular (`far`), light (`fal`), duotone (`fad`), and brands (`fab`). This helps in categorizing icons based on their style and ensuring the correct rendering of the icon.

"fas" | "far" | "fal" | "fad" | "fab"

IconName

Represents the names of available icons. This type is used to ensure that only valid icon names are used within the Font Awesome ecosystem, preventing errors related to undefined or misspelled icons.

"user" | "coffee" | "car" | "apple-alt"

Other packages similar to @fortawesome/fontawesome-common-types

material-design-icons

This package provides SVG and CSS for Google's Material icons. Similar to @fortawesome/fontawesome-common-types, it offers a wide range of icons but focuses on Material Design aesthetics. It does not provide TypeScript types out of the box.

ionicons

A set of premium icons for use in web, iOS, Android, and desktop apps. Ionicons is similar in providing a comprehensive icon set but is tailored more towards Ionic Framework applications. Like @fortawesome/fontawesome-common-types, it supports various styles but is more focused on mobile and web app development.

typicons.font

Typicons are free-to-use vector icons embedded in a webfont for easy integration with any web project. While it offers a different aesthetic and fewer icons compared to @fortawesome/fontawesome-common-types, it provides a simple way to incorporate icons into web projects without extensive configuration.

README

@fortawesome/fontawesome-common-types - SVG with JavaScript

"I came here to chew bubblegum and install Font Awesome 5 - and I'm all out of bubblegum"

What is this package?

Font Awesome 5 JavaScript packages support TypeScript. This package abstracts out some of the common definitions that those packages use.

Here be dragons

If you are trying to import types from this package we highly recommend you do the following instead as all types in this package are re-exported to the main fontawesome package.

your.ts

import {
  IconName
} from `@fortawesome/fontawesome`

const myIcon: IconName = "..."

Issues and support

Start with GitHub issues and ping us on Twitter if you need to.